audio_form object

This method will delete an existing item from a listbox.

bool delete_list_item(int control_id, int list_index, bool reset_cursor=true, bool speak_highlighted_item=true)

Parameters:
control_id
The control ID of the listbox.
list_index
The list index of the item to delete.
reset_cursor
An optional value specifying whether the cursor should be reset so that no item is highlighted. If set to false, the cursor will move to the previous item.
speak_highlighted_item
An optional parameter specifying whether speech should notify about the deleted item and announce the next highlighted item. If set to false, speech will remain silent.

Return value:
true on success, false on failure.

Remarks:
None.

Example:
// Make a simple form with a few buttons and a listbox.

#include "form.bgt"

audio_form form;

void main()
{
form.create_window("Example Form", true);
int list=form.create_list("&People", 0);
form.add_list_item(list, "Joseph", -1);
form.add_list_item(list, "Samuel", -1);
form.add_list_item(list, "Percival", 1);
form.add_list_item(list, "William", -1);
form.add_list_item(list, "Edward", 0);
form.delete_list_item(list, 2);
int ok=form.create_button("OK");
int cancel=form.create_button("E&xit");
while(true)
{
form.monitor();
wait(5);
if(form.is_pressed(ok))
{
exit();
}
if(form.is_pressed(cancel))
{
exit();
}
if((key_down(KEY_LMENU))&&(key_pressed(KEY_F4)))
{
exit();
}
}
}